home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / whodoor1.zip / WHO_DOOR.DOC < prev    next >
Text File  |  1992-10-07  |  12KB  |  264 lines
  1.  
  2.  
  3.   ┌────╖    ┌────╖                      ┌──────────╖
  4.   ╘╕  ╔╝    ╘╕  ╔╝                      ╘╕  ╔═══╕  ║
  5.    │  ║ ┌──╖ │  ║  ┌─╖ ┌─╖ ┌─────╖       │  ║   │  ║ ┌─────╖ ┌─────╖ ┌──────╖
  6.    │  ║ │  ║ │  ║  │ ║ │ ║ │ ╔═╕ ║       │  ║   │  ║ │ ╔═╕ ║ │ ╔═╕ ║ │ ╔══╕ ║
  7.    │  ║ │  ║ │  ║  │ ╙─┘ ║ │ ║ │ ║       │  ║   │  ║ │ ║ │ ║ │ ║ │ ║ │ ╙──┘ ║
  8.    │  ║ │  ║ │  ║  │ ╔═╕ ║ │ ║ │ ║       │  ║   │  ║ │ ║ │ ║ │ ║ │ ║ │ ╔═╕ ╔╝
  9.    │  ╙─┘  ╙─┘  ║  │ ║ │ ║ │ ╙─┘ ║      ┌┘  ╙───┘  ║ │ ╙─┘ ║ │ ╙─┘ ║ │ ║ │ ╙╖
  10.    ╘════════════╝  ╘═╝ ╘═╝ ╘═════╝      ╘══════════╝ ╘═════╝ ╘═════╝ ╘═╝ ╘══╝
  11.   ╔╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╦╗
  12.   ╚╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╩╝
  13.                           (C) 1992 - Ron Bergeron
  14.  
  15.  
  16.  
  17.   ┌─────────────┐
  18.   │ What is it? │
  19.   └─────────────┘
  20.   Who Door is a set of utilities for your QuickBBS or Remote Access BBS.
  21.   This set includes:
  22.  
  23.   LOGGER.EXE - a program that creates and maintains separate upload and
  24.   download log files of all files transferred on your BBS.  LOGGER will
  25.   also "touch" the filedates of your ZModem uploads.  "Touch" means to set
  26.   the file date to the current system date.  QuickBBS does NOT do this
  27.   normally.
  28.  
  29.   WHO_DOOR.EXE - a door that allows your users to search the log files.
  30.  
  31.   LIMIT.EXE - a program that limits the size of the log files (or ANY
  32.   other ASCII text files) to a sysop-definable number of lines.
  33.  
  34.  
  35.   ┌─────────────┐
  36.   │ Why use it? │
  37.   └─────────────┘
  38.   I wrote LOGGER because I wanted to maintain a record of all file
  39.   transfers.  This allows me to keep track of where all the files come
  40.   from and where they all go.  If I find a file that has a virus in it, I
  41.   can quickly and easily find out where it came from and whether or not
  42.   anyone has downloaded it.  Plus, I just like to keep track of these
  43.   things.
  44.  
  45.   I wrote WHO_DOOR because I had several users that wanted to know if they
  46.   could get a list of the files they had already downloaded.
  47.  
  48.   I wrote LIMIT because I wanted to be able to limit the size of the log
  49.   files that LOGGER creates.
  50.  
  51.  
  52.   ┌─────────────────────┐
  53.   │ How do I set it up? │
  54.   └─────────────────────┘
  55.  
  56.  
  57.   LOGGER
  58.  
  59.   First, you must edit the file WHO_DOOR.CFG to meet your needs.  This
  60.   file is a configuration file and is used by both LOGGER and WHO_DOOR.
  61.   The first line of the file is the name of the download log file.  The
  62.   second line of the file is the name of the upload log file.  These must
  63.   be valid DOS filenames, and may include the path to the file if you want
  64.   to keep the log in a different directory.  Only the first two lines of
  65.   this file are read by the programs.  Any lines that appear after the
  66.   first two lines are treated as comments and are ignored.  A sample
  67.   WHO_DOOR.CFG is included in the package.
  68.  
  69.   LOGGER.EXE *MUST* be run after every user logs off your BBS.  Edit your
  70.   BBS batch file to make this happen.  It must be run from the same
  71.   directory as your SYSTEM.LOG or RA.LOG.
  72.  
  73.   Once you have completed the first two steps, LOGGER will start
  74.   maintaining the file transfer logs.  Since the logs won't contain much
  75.   information for a while, WHO_DOOR won't be very useful at first.
  76.  
  77.   To enable the "touch" feature of LOGGER, use the word "touch" as a
  78.   command line parameter when you run LOGGER.  In other words:
  79.  
  80.                              LOGGER TOUCH
  81.  
  82.  
  83.   Here is a sample of the info stored in the log files:
  84.  
  85.  
  86.   13-Aug-92 14400-Z d:\qbbs\qnew\WHO_DOOR.ZIP - Ron Bergeron
  87.       |        |  |           |                      |
  88.       |        |  |           |                  user name
  89.       |        |  |           |
  90.       |        |  |           +---------- file path & name
  91.       |        |  |
  92.       |        |  +--------------------- protocol Z = ZModem
  93.       |        |                                  X = Xmodem
  94.       |        |                                  S = Sealink
  95.       |        |                                  Y = Ymodem
  96.       |        |                                  G = Ymodem-G
  97.       |        |                                  1 = Xmodem-1K
  98.       |        |
  99.       |        +--------------------------------- baud rate
  100.       |
  101.       +--------------------------------------- date of transfer
  102.  
  103.  
  104.  
  105.   WHO_DOOR
  106.  
  107.   When WHO_DOOR is run, it will ask the user whether they want to search
  108.   the upload or the download log.  Then, it will ask them to enter a text
  109.   string to search for in the log file.  They can enter a name, a file
  110.   name, or a partial name or filename.
  111.  
  112.   WHO_DOOR will then search the log and display information that contains
  113.   the text that they are searching for.
  114.  
  115.   WHO_DOOR.EXE can be set up as either a type 7 or type 15 door.  It
  116.   requires access to your DORINFO1.DEF.  Refer to your BBS software
  117.   documentation for information on how to set up type 7 or 15 menu items.
  118.  
  119.   WHO_DOOR checks the current directory for the presence of the file
  120.   IGNORE.CFG.  This file is a configuration file that contains a list of
  121.   up to 50 directories that you do not want WHO_DOOR to display information
  122.   about. This can be handy if you have "Adult" areas of your BBS and don't
  123.   want anyone to be able to see who is active in these areas.  If you
  124.   do not have a IGNORE.CFG file, WHO_DOOR will display ALL available
  125.   information to your users.
  126.  
  127.   When WHO_DOOR is searching the log file and finds the information that
  128.   the user is searching for, it first checks the IGNORE.CFG file.  If the
  129.   directory that the search text appears in is also in the IGNORE.CFG, it
  130.   will NOT display the information to the user UNLESS the user was the
  131.   person who transferred the file.
  132.  
  133.   For example, if your IGNORE.CFG contains the line:
  134.                         ┌────────────────────┐
  135.                         │  d:\files\xxx_txt  │
  136.                         └────────────────────┘
  137.  
  138.   and your download log file contains the lines:
  139.     ┌─────────────────────────────────────────────────────────────┐
  140.     │ 13-Aug-92  2400-Z d:\files\xxx_txt\ADULT.ZIP - John Doe     │
  141.     │ 13-Aug-92 14400-Z d:\files\xxx_txt\ADULT.ZIP - Ron Bergeron │
  142.     └─────────────────────────────────────────────────────────────┘
  143.  
  144.   and I enter this door and search for "ADULT", this is what would happen:
  145.  
  146.   WHO_DOOR would open the download log file and start looking for the text
  147.   "ADULT".  When it found the text in the first line, it would then check
  148.   the IGNORE.CFG and see that this directory is to be ignored.  It would
  149.   then check to see if I were the one who transferred the file.  Since I
  150.   was not, WHO_DOOR would NOT display the info.
  151.  
  152.   When WHO_DOOR found the text in the next line, the same thing would
  153.   happen, only this time, it would see that I was the one who transferred
  154.   the file and so it WOULD display the information to me.
  155.  
  156.   This way, the privacy of your users is protected, but they can still get
  157.   a complete listing of the files that they have transferred.
  158.  
  159.  
  160.  
  161.   LIMIT
  162.  
  163.   LIMIT will limit the number of lines in ANY standard ASCII text file to
  164.   the number specified on the command line.
  165.  
  166.   This is how it is used:
  167.  
  168.    ┌────────────────────────────────────────────────────────────────────┐
  169.    │   Usage:  LIMIT <filename> <number of lines>                       │
  170.    │                                                                    │
  171.    │   "Filename" is the name of the file that you want to trim down.   │
  172.    │                                                                    │
  173.    │   "Number of lines" is the number of lines that you want the file  │
  174.    │   to have after it is trimmed.  The excess lines are removed from  │
  175.    │   BEGINNING of the file.                                           │
  176.    └────────────────────────────────────────────────────────────────────┘
  177.  
  178.   If you have many file transfers on your BBS, you may want to use
  179.   LIMIT in your nightly event to keep the your upload and download
  180.   log files limited to a reasonable size.
  181.  
  182.  
  183.   ┌──────────────┐
  184.   │ Registration │
  185.   └──────────────┘
  186.   These programs are NOT freeware!  If you use them on your BBS for more than
  187.   three weeks, you are required to register them.  Run the program REGISTER.EXE
  188.   if you decide to register.  When you register, your BBS name will appear
  189.   in place of the bright yellow [UNREGISTERED] displayed in the door. This
  190.   will show your callers that YOU support shareware!  Also, the 6 second
  191.   delay that occurs when LOGGER runs will disappear.
  192.  
  193.  
  194.   ┌───────────┐
  195.   │ Copyright │
  196.   └───────────┘
  197.   WHO_DOOR, LOGGER, and LIMIT, Copyright 1992 by Ron Bergeron, are being
  198.   distributed as Shareware.  Under this concept you may use the SHAREWARE
  199.   (unregistered) versions for a reasonable period of time (3 weeks) for
  200.   evaluation after which you must either register your copies or remove
  201.   them from use on your BBS.
  202.  
  203.  
  204.   ┌──────────┐
  205.   │ Warranty │
  206.   └──────────┘
  207.   This product is provided AS-IS without warranty of any kind.  The entire
  208.   risk as to the results and performance of the programs is assumed by you.
  209.   Futhermore, the author does not warrant, guarantee, or make any other
  210.   representations regarding the use of, or the results of the use of the
  211.   program, and you rely on the program and results solely at your own
  212.   risk.  The author cannot and will not accept responsibility for system
  213.   damage, loss of profit or any other special, consequential or incidental
  214.   damages resulting from the use of or inability to use this product.
  215.  
  216.  
  217.   ┌────────────┐
  218.   │ Trademarks │
  219.   └────────────┘
  220.   QuickBBS is a trademark of Pegasus Software.  RemoteAccess is a
  221.   trademark of Continental Software.
  222.  
  223.  
  224.   ┌───────────┐
  225.   │ Questions │
  226.   └───────────┘
  227.   I can be reached for questions or comments on my BBS.
  228.  
  229.                                 The Machine
  230.                                (508)948-2921
  231.                              FidoNet 1:324/124
  232.  
  233.  
  234.   ┌────────────────┐
  235.   │ Other programs │
  236.   └────────────────┘
  237.  
  238.   Other programs written by Ron Bergeron:
  239.  
  240.   REPEAT31.ZIP  39,372 bytes   The Repeat Door.  This is the door version of
  241.                                the popular kid's game "Simon".  Test your short
  242.                                term memory. Maintains top ten list.
  243.                                Colorful and interesting.  Works with
  244.                                QuickBBS, Remote Access, Spitfire, and
  245.                                PCBoard.
  246.  
  247.   LOTTO30.ZIP   36,759 bytes   Simple, colorful, and different ANSI
  248.                                gambling-for-time door.  Works with
  249.                                QuickBBS and Remote Access.
  250.  
  251.   VCHECK10.ZIP  36,246 bytes   The Virus Check Door.  This door allows your
  252.                                users to test .ZIP and .ARJ files for both arc
  253.                                integrity and viruses (using McAfee's
  254.                                SCAN.EXE).  Give your users that extra
  255.                                level of security - let them test for
  256.                                themselves before downloading.  Maintains
  257.                                log file, if desired.  Works with QuickBBS
  258.                                and Remote Access.
  259.  
  260.   COMMENT!.ZIP  13,793 bytes   .ZIP file comment program.  Insert/replace
  261.                                comments in your .ZIP files.  Will maintain
  262.                                original .ZIP file date.  Fast, efficient,
  263.                                and RELIABLE.
  264.